home *** CD-ROM | disk | FTP | other *** search
/ Sprite 1984 - 1993 / Sprite 1984 - 1993.iso / src / lib / c / etc / Stat.man < prev    next >
Encoding:
Text File  |  1991-01-26  |  1.5 KB  |  56 lines
  1. '\" Copyright 1991 Regents of the University of California
  2. '\" Permission to use, copy, modify, and distribute this
  3. '\" documentation for any purpose and without fee is hereby
  4. '\" granted, provided that this notice appears in all copies.
  5. '\" The University of California makes no representations about
  6. '\" the suitability of this material for any purpose.  It is
  7. '\" provided "as is" without express or implied warranty.
  8. '\" 
  9. '\" $Header: /sprite/src/lib/c/etc/RCS/Stat.man,v 1.1 91/01/25 17:15:51 kupfer Exp $ SPRITE (Berkeley)
  10. '/" 
  11. .so \*(]ltmac.sprite
  12. .HS Stat lib
  13. .BS
  14. '\" Note:  do not modify the .SH NAME line immediately below!
  15. .SH NAME
  16. Stat_GetMsg, Stat_PrintMsg \- Text description of Sprite status codes
  17. .SH SYNOPSIS
  18. .nf
  19. \fB#include <status.h>\fR
  20. .sp
  21. char *
  22. \fBStat_GetMsg\fR(\fIstatus\fP)
  23. .sp
  24. void
  25. \fBStat_PrintMsg\fR(\fIstatus\fR, \fIstring\fR)
  26. .SH ARGUMENTS
  27. .AS ReturnStatus *string
  28. .AP ReturnStatus status in
  29. Status code to return text for.
  30. .AP char *string in
  31. Supplemental string to be printed.
  32. .BE
  33.  
  34. .SH DESCRIPTION
  35. .PP
  36. These functions provide a human-readable text string for a given
  37. Sprite status value.
  38. .B Stat_GetMsg
  39. returns a read-only string to the caller.
  40. .B Stat_PrintMsg 
  41. prints a message on the standard error stream.  The message looks like
  42. ``\fIstring\fR: \fImessage\fR'', where
  43. .I string
  44. is passed in by the caller, and
  45. .I message
  46. is obtained by calling 
  47. .BR Stat_GetMsg .
  48. The
  49. .I string
  50. may be null, in which case only the
  51. .I message
  52. is printed.
  53.  
  54. .SH KEYWORDS
  55. status
  56.